DRAFT: Docs coding best practices - #179
Merged
Merged
Conversation
aleaf
marked this pull request as draft
September 24, 2025 15:11
aleaf
marked this pull request as ready for review
September 24, 2025 15:11
Collaborator
|
This is an awesome start @aleaf! I looked it over and looks really good to me. I could see making some updates or edits at some point, but I'm inclined to incorporate it into the main repo and happy for you to present it in the class wrapup as well |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Thowing up a draft reference page of "best practices" for the html docs. Thinking that I can briefly discuss these topics in the last session for the Part 0 general course, especially the "Tips for writing 'Good Code'". And then the rest can be available as reference material. Also added a page with references for making a python package.
@mnfienen @jlarsen-usgs @ntdosch @kallejahn keen to get your input on the (opinionated) "best practices" page. You can view the rendered page here, or the source markdown. Feel free to comment in this PR (not sure if we've got the GitHub review machinery set up), or to push edits directly.